home *** CD-ROM | disk | FTP | other *** search
/ Risc World 3 / Risc World 3.iso / SOFTWARE / ISSUE6 / PD / XCHARS / !XChars / !Help next >
Text File  |  2003-02-05  |  18KB  |  332 lines
  1. XChars 1.20 (05-Feb-2003)
  2.  
  3. Name:     XChars
  4. Purpose:  Advanced chars utility
  5. Author:   Martin Würthner
  6. Requires: RISC OS 3.1 or higher, 32-bit SharedCLib
  7. Status:   FREEWARE (see below)
  8. WWW:      http://www.mw-software.com/
  9.  
  10. XChars is a replacement for the Chars utility that comes with RISC OS
  11. with a lot of additional features, such as:
  12. - multiple windows
  13. - outline fonts at arbitrary sizes
  14. - support for different encodings
  15. - font aspect, line and character spacing control
  16. - different arrangements of characters (+optional display of ctrl chars)
  17. - configurable default settings
  18. - character zoom window at configurable size by clicking Adjust on a letter
  19.   (during the duration of the button press only or as a persistent window)
  20. - configurable character insertion hot key
  21. - option to install an application icon on the icon bar
  22. - all options can be set independently in each window
  23. - "hotlist": the state of all options (font,font size,line spacing etc.) of
  24.   a window can be saved (by associating a name with it) and restored later
  25.   from the hotlist menu
  26. - automatic display of character code under the pointer
  27.  
  28. 1) How to use XChars
  29. ====================
  30. Double-click on the !XChars application icon in a Filer window to load it.
  31. Depending on the Startup options which have been set up, the application
  32. installs an icon on the icon bar and/or opens a character display window.
  33.  
  34. The XChars window
  35. -----------------
  36. Each window shows the full character set in the given font and encoding. If you
  37. click SELECT on a character, it is inserted at the caret position in the
  38. application which currently owns the input focus (the window with the cream
  39. title bar).
  40.   If you click ADJUST, the character is displayed in a bigger 'zoom' window
  41. (note that this only works with outline fonts, not with the System font!).
  42. Depending on the 'Persistent zoom window' option in the Choices window (see
  43. below under "Choices window"), the zoom window disappears automatically as soon
  44. as you release the ADJUST button or it remains on screen (in the latter case it
  45. is called persistent). The persistent zoom window has a close icon, so you can
  46. close it just as any other window. To reopen it, simply click ADJUST again in
  47. any XChars window.
  48.   The font size to be used in the zoom window can be changed in the Display
  49. options window (see below).
  50.   When trying to enter text in a writable menu field or a transient dialogue
  51. box, the SELECT click method cannot be used, because this would cause the
  52. destination window to disappear. To overcome this problem, you can also insert
  53. a character by placing the pointer over it and pressing the character insertion
  54. hotkey (e.g. Ctrl). The hotkey to be used can be configured in the Choices
  55. window (see below, "The Choices window").
  56.  
  57. Changing the font, font size etc.
  58. ---------------------------------
  59. The toolbar (at the top of each character window) shows the current font and
  60. the font size. The font can be changed by clicking on the pop-up menu button
  61. next to the font name and choosing a font from the menu.
  62.   If the current font is an outline font (i.e. not the System font), then  The
  63. size can be changed by using the up/down arrows or entering a number in the
  64. input field. The change only takes effect if you click on the OK button. A
  65. quicker way of changing the font size is to choose a size from the font size
  66. menu which appears if you click on the pop-up menu button next to the font size
  67. input field. This changes the font size immediately.
  68.   The arrangement of the characters can be changed from the window's menu: You
  69. can choose between 32 by 8,16 by 16 and 8 by 32. Also, if you select the option
  70. 'Show ctrl', then the window shows the control characters at the top row as
  71. inverted letters. So, e.g. to enter Ctrl-C, click SELECT on the inverted letter
  72. 'C'. Ticking 'Show grid' shows the character grid (see below, "Character
  73. grid").
  74.   More advanced options are found in the Display options window: Choose
  75. 'Display options' from the window's menu to open it:
  76.  
  77. The Display options window:
  78. ---------------------------
  79. In this window you can change the font aspect, the line and character spacing
  80. and zoom font size. The font aspect determines the width of the characters in
  81. relation to their height. Normally, characters are displayed at 100% which is
  82. the default. If the aspect ratio is smaller than 100%, the characters appear
  83. narrow, if it is greater than 100%, they are expanded.
  84.   The next two options, line spacing and char spacing can in most cases be left
  85. at their default values, i.e. at 100%. XChars automatically leaves enough room
  86. vertically to accomodate even the highest character of the font. Horizontally,
  87. it uses by default 80% of the widest character (i.e. this corresponds to char
  88. spacing 100%) which is enough in almost all cases as it is very unlikely that
  89. two very wide characters are next to each other.
  90.   However, if you want more (or less) space between the rows/columns, then you
  91. can increase (or decrease) the line/char spacing.
  92.   The last value is the font size to be used in the character zoom window (this
  93. is the window you call up by clicking ADJUST on a character). This is set for
  94. each window individually, so if you have a persistent zoom box (or if you press
  95. and hold Adjust) the size of the zoom window may change as you move from one
  96. window to another.
  97.   If you switch "Display character code" on, the character code of the
  98. character under the pointer is displayed near the pointer in a small yellow box
  99. which also moves as you move the pointer. The code can be displayed in decimal
  100. or hexadecimal notation or both at the same time depending on which of the
  101. three radio icons in the line below you select. These options can be switched
  102. on/off for each window individually. Probably not a feature you would want to
  103. switch on for every window, but it was added by popular demand, so at least
  104. some people will hopefully find this useful. What about adding a definition of
  105. a System font window with "Display character code" switched on to your hotlist?
  106. This way you have quick access to character codes in case you need them. If you
  107. should really want this feature for every window, simply modify your default
  108. setup.
  109.  
  110. Encodings
  111. ---------
  112. The RISC OS FontManager supports rendering text in different encodings
  113. (different choices of character sets), as long as the font used supplies
  114. encoding information. This allows you to access additional characters some
  115. fonts supply. This is the case for the ROM fonts, which amongst others, include
  116. a lot of accented characters for use in Eastern European languages.
  117.   Unless you specify an encoding, the system's default encoding is used (Latin1
  118. for most users). You may change the encoding by switching from the font toolbar
  119. to the encoding toolbar: To do this, click on the toolbar switch icon - this is
  120. the small icon to the left of the font name display field that looks like two
  121. small option buttons, the top one selected, the bottom one deselected.
  122.   The encoding toolbar shows the current encoding and allows you to change it
  123. by choosing a different one from the encodings menu. The encodings menu shows
  124. the different encodings that are installed on your system.
  125.   As mentioned above, changing the encoding may or may not make any difference.
  126. At least for the three standard ROM fonts Trinity, Homerton and Corpus, you
  127. should see different (and possibly new) characters when you change from
  128. "(Default)" to, say, "Latin2". If you have a "Greek" encoding (standard under
  129. RISC OS 5), then can see how the greek characters in the Sidney maths font
  130. map to the standard positions for a modern greek font when applying the
  131. "Greek" encoding.
  132.   In general, applying encodings does not make much sense for symbol fonts
  133. because most of their glyphs are not found in any of the standard "language"
  134. encodings. So Selwyn with anything other than the "(Default)" encoding looks
  135. pretty empty.
  136.   Please note: If you click on a character to insert it at the caret position,
  137. then you will only see the same character in the application that receives it
  138. if you have chosen the same font with the same encoding in this application.
  139. Unfortunately, most applications do not allow you change the font encoding and
  140. will always use the default system encoding. Cerilica Vantage is one example of
  141. an application that supports encodings.
  142.   To switch back to the font toolbar, simply click on the toolbar switch icon
  143. again.
  144.  
  145. Entering characters into applications
  146. -------------------------------------
  147. You can "enter" characters at the current caret position by either clicking on
  148. them with Select or by pressing the character insertion hotkey while the mouse
  149. pointer is over the character. The latter is useful when inserting characters
  150. into writable submenu fields that would vanish if you clicked a mouse button.
  151. See "The choise window" to find out how to configure the character insertion
  152. hotkey.
  153.   Please note that either method only sends the bare character. Neither sends
  154. any font information to the application owning the caret, so you will only see
  155. the same character in the application if you have chosen the same font (and the
  156. same encoding, if the one you have chosen in XChars is not "(Default)").
  157.  
  158. Default settings
  159. ----------------
  160. The whole set of options can be saved as the default by choosing 'Save as
  161. default' from the window's menu. This means that any new window now has
  162. the properties of the current window, e.g. the font, encoding, font size etc.
  163.   This is saved to disc, so the next time you start the application it will
  164. still remember which default settings to use.
  165.  
  166. The hotlist
  167. -----------
  168. One of the most powerful features of XChar is the hotlist: You can add the
  169. complete state of a window including all options to the hotlist and give
  170. it a name. By choosing the entry from a menu later, you can recall the
  171. settings you associated with that name.
  172.   Supposed you use Dingbats quite often and you want it to be displayed at
  173. 24pt with a line spacing of 120%. Instead of setting all these options
  174. every time you want to view Dingbats, you can set them once and then add
  175. the current window state to the hotlist:  Click menu over the window and
  176. follow the submenu arrow of the entry "Add to hotlist". Then, type the name
  177. which you want to associate with these settings, e.g. "Dingbats" and click
  178. on OK.
  179.   To recall the settings later, click on the "A" icon to the left of the
  180. tool bar. This displays the hotlist. The first entry of the hotlist is
  181. always "Default". Choosing this restores the default settings. Below this
  182. entry, you can see all the additional entries. Choosing one of these
  183. restores the settings associated with the corresponding entry.
  184.   If you want to modify one of the entries, choose it, change the options,
  185. and then use "Add to hotlist" again without changing the name in the
  186. writable field. This overwrites the old definition with your modified one.
  187. A hotlist entry can be removed by choosing its name from the "Remove"
  188. sub-menu.
  189.   Like the default settings, the hotlist is immediately saved to disc
  190. every time you modify it.
  191.  
  192. The Choices window
  193. ------------------
  194. The Choices window is opened by choosing 'Choices...' from the icon bar menu.
  195. Obviously, this is only possible if there is an XChars icon on the icon bar.
  196. If there is not, the 'Choices...' entry is present in the main menu obtained
  197. by clicking Menu over any XChars window.
  198.   The Choices window allows you to configure some options which are global
  199. and do not belong to a particular window. These are the startup options,
  200. the character insertion hotkey and the zoom window behaviour:
  201.   When the application starts up it can either install an icon on the
  202. icon bar or open a window (or do both). Of course, doing neither of
  203. both is not sensible as in this case you could not access the application
  204. at all! This option only takes effect if you quit and re-load the
  205. application.
  206.   The character insertion hotkey can be either of Ctrl, Shift or Alt. As
  207. each of these keys appear twice on the keyboard, you can choose which one
  208. is to be used. If you want both keys to be active, select both option icons,
  209. 'Left key' and 'Right key'. By deselecting both option icons, the whole
  210. feature (character insertion by hotkey) can be disabled.
  211.   The last option in the Choices window determines whether the zoom window
  212. stays on the screen when you release the Adjust button of the mouse (this
  213. happens if the option 'Persistent zoom window' is switched on) or whether
  214. it is closed automatically (if the option is switched off).
  215.  
  216. Character grid
  217. --------------
  218. Some fonts have characters which behave odd in terms of positioning because
  219. they appear to the left or right of their bounding box. For example, this
  220. happens with the vowels of classical Hebrew fonts, e.g. HolyBible.HebClassic
  221. (by ExpLAN Computers) or Royal.BblcHbrw (by EFF) because the vowels have to
  222. appear underneath the preceding consonant.
  223.   The click-sensitive zone of each character is linked to a global bounding
  224. box, so clicking on one of these characters sometimes seems to insert the
  225. wrong one.
  226.   One thing which helps is to increase the character spacing (e.g. to 140%),
  227. but even then, you have to click exactly on the vowels or to the left of them.
  228. If you switch on the character grid (main menu 'Arrangement.Show Grid'), you
  229. see the click-sensitive zone of each character.
  230.   The submenu allows you to choose the grid colour.
  231.  
  232. The XChars icon on the icon bar
  233. -------------------------------
  234. Clicking SELECT on the XChars icon opens a new window with the current
  235. default settings.
  236. Clicking ADJUST on the XChars icon brings the most recently used window to
  237. the top. Pressing SHIFT at the same time brings all the windows to the top.
  238. While there is no open XChars window at all, clicking ADJUST on the XChars
  239. icon re-opens the most recently closed XChars window (in contrast to SELECT,
  240. which opens a new window with the default settings). This is useful if you
  241. tend to close XChars windows when you do not need them at the moment and
  242. then regret this later because you would like to have the same window again
  243. without having to setup the settings all over again.
  244.  
  245. Quitting the application
  246. ------------------------
  247. You can quite XChars by choosing 'Quit' from the icon bar menu. If there is
  248. no XChars icon on the icon bar, the application quits as soon as you close
  249. the last open window.
  250.  
  251. Distributing this application to other people
  252. ---------------------------------------------
  253. You are allowed to give this application to anyone you want (terms and
  254. conditions, see below under "Copyright message").
  255.   After copying it, you should delete the files "Default" and "Hotlist"
  256. files inside the copied !XChars directory. Otherwise, the default settings
  257. or the entries in the hotlist may contain names of fonts which are not
  258. present on the destination system leading to error messages.
  259.   Be careful not to delete anything else!
  260.  
  261. Credits
  262. -------
  263. Thanks to Neil Walker for his !ZoomChars application. I borrowed his idea
  264. of providing a zoom window, transient or persistent. Thanks to Harriet Bazley
  265. for her request to be able to re-open the most recently closed window.
  266.  
  267. 2) History
  268. ==========
  269. 1.20 (05-Feb-03):
  270.   - added support for encodings
  271.   - flickering in zoom window fixed
  272.   - ticks appear correctly in the font menu if a font is chosen using the
  273.     Adjust mouse button
  274.   - character codes can be displayed in both decimal and hex at the same time
  275. 1.10b (17-Dec-02):
  276.   - corrected release archive with files in !XChars directory
  277. 1.10 (22-Nov-02):
  278.   - compiled with 32-bit compiler tools, so works in 32-bit mode, but requires
  279.     the new 32-bit SharedCLib
  280.   - now uses the sprite designed by Andy George as standard
  281. 1.08 (16-Jun-01):
  282.   - auto-repeat for clicks
  283. 1.07 (27-Feb-01):
  284.   - ADJUST clicking on icon bar while no window is open re-opens last window
  285.   - Hex character code display
  286.   - Messages file contains messages for dialogue boxes as well
  287. 1.06 (28-Feb-00):
  288.   - Default entry in "add to hotlist" window
  289.   - documentation update
  290. 1.05 (03-Nov-96):
  291.   - The character and its code are now also displayed in the zoom window's
  292.     title bar
  293. 1.04 (22-Jan-96):
  294.   - Because of popular demand: "Display character code" option added to display
  295.     the code of the character under the pointer
  296. 1.03 (20-Jan-96):
  297.   - Why did not anybody tell me that this thing did not really work with
  298.     dialogue boxes (e.g. Zap and Impression)? Embarassing... Now uses
  299.     Wimp_ProcessKey instead of sending a KeyPressed message to the destination
  300.     task. So simple...
  301. 1.02 (14-Dec-95):
  302.   - minimum window width can be smaller with System font as font size icons
  303.     in toolbar cannot be accessed anyway -> smaller window in System font mode
  304.   - added ADJUST and SHIFT-ADJUST click actions on icon bar icon
  305.   - added character grid option
  306. 1.01 (28-Nov-95):
  307.   - sensitive boxes around characters are now centred
  308. 1.00 (24-Nov-95):
  309.   - first version sent to Hensa and Stuttgart
  310.  
  311. 3) Copyright message
  312. ====================
  313. This application, XChars, is © Martin Würthner, 2003 and is FREEWARE.
  314. This means that you may copy it freely provided that
  315. (a) all files of this application are distributed together without
  316.     modification (see above: "Distribution this application...")
  317. (b) this application is not sold for profit without my explicit written
  318.     permission (this includes distribution on CD)
  319.  
  320. 4) Contacting me
  321. ================
  322. Martin Wuerthner
  323. Mannheimer Str. 18
  324. 67655 Kaiserslautern
  325. Germany
  326.  
  327. Phone: +49-(0)631-3608205
  328. Fax:   +49-(0)631-3608203
  329.  
  330. e-mail: martin@mw-software.com
  331. WWW:    http://www.mw-software.com/
  332.